{BackupManagementType} [backupManagementType] Type of backup
managemenent for the container. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional canReRegister
canReRegister:undefined | false | true
member
{boolean} [canReRegister] Specifies whether the container is
re-registrable.
Optional containerId
containerId:undefined | string
member
{string} [containerId] ID of container.
containerType
containerType:"AzureBackupServerContainer"
member
{string} containerType Polymorphic Discriminator
Optional dpmAgentVersion
dpmAgentVersion:undefined | string
member
{string} [dpmAgentVersion] Backup engine Agent version
Optional dpmServers
dpmServers:string[]
member
{string[]} [dpmServers] List of BackupEngines protecting the
container
{BackupManagementType} [backupManagementType] Type of backup
management for the backup engine. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional canReRegister
canReRegister:undefined | false | true
member
{boolean} [canReRegister] Flag indicating if the backup engine be
registered, once already registered.
{ProtectionStatus} [protectionState] State of the back up item.
Possible values include: 'Invalid', 'NotProtected', 'Protecting',
'Protected', 'ProtectionFailed'
serializedName
serializedName:string = "AzureFileShare"
Optional workloadType
workloadType:undefined | string
member
{string} [workloadType] Type of workload for the backup management
{RestoreRequestType} [restoreRequestType] Restore Type
(FullShareRestore or ItemLevelRestore). Possible values include:
'Invalid', 'FullShareRestore', 'ItemLevelRestore'
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the backed up item. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional backupSetName
backupSetName:undefined | string
member
{string} [backupSetName] Name of the backup set the backup item
belongs to
{CreateMode} [createMode] Create mode to indicate recovery of
existing soft deleted data source or creation of new data source. Possible
values include: 'Invalid', 'Default', 'Recover'
{HealthStatus} [healthStatus] backups running status for this
backup item. Possible values include: 'Passed', 'ActionRequired',
'ActionSuggested', 'Invalid'
Optional lastBackupStatus
lastBackupStatus:undefined | string
member
{string} [lastBackupStatus] Last backup operation status. Possible
values: Healthy, Unhealthy.
Optional lastBackupTime
lastBackupTime:Date
member
{Date} [lastBackupTime] Timestamp of the last backup operation on
this backup item.
Optional lastRecoveryPoint
lastRecoveryPoint:Date
member
{Date} [lastRecoveryPoint] Timestamp when the last (latest) backup
copy was created for this backup item.
Optional policyId
policyId:undefined | string
member
{string} [policyId] ID of the backup policy with which this item
is backed up.
{ProtectionState} [protectionState] Backup state of this backup
item. Possible values include: 'Invalid', 'IRPending', 'Protected',
'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'
Optional protectionStatus
protectionStatus:undefined | string
member
{string} [protectionStatus] Backup status of this backup item.
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the container. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
{ProtectionStatus} [protectionState] State of the back up item.
Possible values include: 'Invalid', 'NotProtected', 'Protecting',
'Protected', 'ProtectionFailed'
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the backed up item. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional backupSetName
backupSetName:undefined | string
member
{string} [backupSetName] Name of the backup set the backup item
belongs to
{CreateMode} [createMode] Create mode to indicate recovery of
existing soft deleted data source or creation of new data source. Possible
values include: 'Invalid', 'Default', 'Recover'
{ProtectionState} [protectionState] Backup state of this backup
item. Possible values include: 'Invalid', 'IRPending', 'Protected',
'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'
Optional protectionStatus
protectionStatus:undefined | string
member
{string} [protectionStatus] Backup status of this backup item.
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the container. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
containerType
containerType:"Microsoft.Compute/virtualMachines"
member
{string} containerType Polymorphic Discriminator
Optional friendlyName
friendlyName:undefined | string
member
{string} [friendlyName] Friendly name of the container.
Optional healthStatus
healthStatus:undefined | string
member
{string} [healthStatus] Status of health of the container.
Optional registrationStatus
registrationStatus:undefined | string
member
{string} [registrationStatus] Status of registration of the
container with the Recovery Services Vault.
Optional resourceGroup
resourceGroup:undefined | string
member
{string} [resourceGroup] Resource group name of Recovery Services
Vault.
{ProtectionStatus} [protectionState] State of the back up item.
Possible values include: 'Invalid', 'NotProtected', 'Protecting',
'Protected', 'ProtectionFailed'
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the backed up item. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional backupSetName
backupSetName:undefined | string
member
{string} [backupSetName] Name of the backup set the backup item
belongs to
{CreateMode} [createMode] Create mode to indicate recovery of
existing soft deleted data source or creation of new data source. Possible
values include: 'Invalid', 'Default', 'Recover'
{ProtectionState} [protectionState] Backup state of this backup
item. Possible values include: 'Invalid', 'IRPending', 'Protected',
'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'
Optional protectionStatus
protectionStatus:undefined | string
member
{string} [protectionStatus] Backup status of this backup item.
{BackupManagementType} [backupManagementType] Backup management
type to execute the current job. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional duration
duration:undefined | string
member
{string} [duration] Time elapsed during the execution of this job.
Optional endTime
endTime:Date
member
{Date} [endTime] The end time.
Optional entityFriendlyName
entityFriendlyName:undefined | string
member
{string} [entityFriendlyName] Friendly name of the entity on which
the current job is executing.
Optional errorDetails
errorDetails:AzureIaaSVMErrorInfo[]
member
{AzureIaaSVMErrorInfo[]} [errorDetails] Error details on execution
of this job.
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the backed up item. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional backupSetName
backupSetName:undefined | string
member
{string} [backupSetName] Name of the backup set the backup item
belongs to
{CreateMode} [createMode] Create mode to indicate recovery of
existing soft deleted data source or creation of new data source. Possible
values include: 'Invalid', 'Default', 'Recover'
{ProtectionState} [protectionState] Backup state of this backup
item. Possible values include: 'Invalid', 'IRPending', 'Protected',
'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'
Optional protectionStatus
protectionStatus:undefined | string
member
{string} [protectionStatus] Backup status of this backup item.
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the backed up item. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional itemId
itemId:undefined | string
member
{string} [itemId] ID of the item which is getting protected, In
case of Azure Vm , it is ProtectedItemId
Optional policyId
policyId:undefined | string
member
{string} [policyId] ID of the backup policy with which this item
is backed up.
{ProtectionStatus} [protectionState] Backup state of this backup
item. Possible values include: 'Invalid', 'NotProtected', 'Protecting',
'Protected', 'ProtectionFailed'
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the backed up item. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional friendlyName
friendlyName:undefined | string
member
{string} [friendlyName] Friendly name of the VM represented by
this backup item.
Optional itemId
itemId:undefined | string
member
{string} [itemId] ID of the item which is getting protected, In
case of Azure Vm , it is ProtectedItemId
Optional policyId
policyId:undefined | string
member
{string} [policyId] ID of the backup policy with which this item
is backed up.
{ProtectionStatus} [protectionState] Backup state of this backup
item. Possible values include: 'Invalid', 'NotProtected', 'Protecting',
'Protected', 'ProtectionFailed'
serializedName
serializedName:string = "AzureResourceItem"
Optional sourceResourceId
sourceResourceId:undefined | string
member
{string} [sourceResourceId] ARM ID of the resource to be backed
up.
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the container. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the container. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
containerType
containerType:"AzureSqlContainer"
member
{string} containerType Polymorphic Discriminator
Optional friendlyName
friendlyName:undefined | string
member
{string} [friendlyName] Friendly name of the container.
Optional healthStatus
healthStatus:undefined | string
member
{string} [healthStatus] Status of health of the container.
Optional registrationStatus
registrationStatus:undefined | string
member
{string} [registrationStatus] Status of registration of the
container with the Recovery Services Vault.
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the backed up item. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional backupSetName
backupSetName:undefined | string
member
{string} [backupSetName] Name of the backup set the backup item
belongs to
{CreateMode} [createMode] Create mode to indicate recovery of
existing soft deleted data source or creation of new data source. Possible
values include: 'Invalid', 'Default', 'Recover'
{ProtectedItemState} [protectionState] Backup state of the backed
up item. Possible values include: 'Invalid', 'IRPending', 'Protected',
'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the container. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
containerType
containerType:"StorageContainer"
member
{string} containerType Polymorphic Discriminator
Optional friendlyName
friendlyName:undefined | string
member
{string} [friendlyName] Friendly name of the container.
Optional healthStatus
healthStatus:undefined | string
member
{string} [healthStatus] Status of health of the container.
Optional protectedItemCount
protectedItemCount:undefined | number
member
{number} [protectedItemCount] Number of items backed up in this
container.
Optional registrationStatus
registrationStatus:undefined | string
member
{string} [registrationStatus] Status of registration of the
container with the Recovery Services Vault.
Optional resourceGroup
resourceGroup:undefined | string
member
{string} [resourceGroup] Resource group name of Recovery Services
Vault.
serializedName
serializedName:string = "StorageContainer"
Optional sourceResourceId
sourceResourceId:undefined | string
member
{string} [sourceResourceId] Fully qualified ARM url.
{BackupManagementType} [backupManagementType] Backup management
type to execute the current job. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional duration
duration:undefined | string
member
{string} [duration] Time elapsed during the execution of this job.
Optional endTime
endTime:Date
member
{Date} [endTime] The end time.
Optional entityFriendlyName
entityFriendlyName:undefined | string
member
{string} [entityFriendlyName] Friendly name of the entity on which
the current job is executing.
Optional errorDetails
errorDetails:AzureStorageErrorInfo[]
member
{AzureStorageErrorInfo[]} [errorDetails] Error details on
execution of this job.
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the container. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional containerId
containerId:undefined | string
member
{string} [containerId] Fabric Id of the container such as ARM Id.
Optional friendlyName
friendlyName:undefined | string
member
{string} [friendlyName] Friendly name of the container.
Optional healthStatus
healthStatus:undefined | string
member
{string} [healthStatus] Status of health of the container.
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the container. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional containerId
containerId:undefined | string
member
{string} [containerId] Fabric Id of the container such as ARM Id.
Optional friendlyName
friendlyName:undefined | string
member
{string} [friendlyName] Friendly name of the container.
Optional healthStatus
healthStatus:undefined | string
member
{string} [healthStatus] Status of health of the container.
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the container. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
{ProtectionStatus} [protectionState] State of the back up item.
Possible values include: 'Invalid', 'NotProtected', 'Protecting',
'Protected', 'ProtectionFailed'
serializedName
serializedName:string = "AzureVmWorkloadItem"
Optional serverName
serverName:undefined | string
member
{string} [serverName] Host/Cluster Name for instance or AG
Optional subWorkloadItemCount
subWorkloadItemCount:undefined | number
member
{number} [subWorkloadItemCount] For instance or AG, indicates
number of DB's to be protected
Optional subinquireditemcount
subinquireditemcount:undefined | number
member
{number} [subinquireditemcount] For instance or AG, indicates
number of DB's present
An interface representing AzureVmWorkloadProtectableItem.
Azure VM workload-specific protectable item.
Optional backupManagementType
backupManagementType:undefined | string
member
{string} [backupManagementType] Type of backup managemenent to
backup an item.
Optional friendlyName
friendlyName:undefined | string
member
{string} [friendlyName] Friendly name of the backup item.
Optional isAutoProtectable
isAutoProtectable:undefined | false | true
member
{boolean} [isAutoProtectable] Indicates if protectable item is
auto-protectable
Optional isAutoProtected
isAutoProtected:undefined | false | true
member
{boolean} [isAutoProtected] Indicates if protectable item is
auto-protected
Optional parentName
parentName:undefined | string
member
{string} [parentName] Name for instance or AG
Optional parentUniqueName
parentUniqueName:undefined | string
member
{string} [parentUniqueName] Parent Unique Name is added to provide
the service formatted URI Name of the Parent
Only Applicable for data bases where the parent would be either Instance
or a SQL AG.
{ProtectionStatus} [protectionState] State of the back up item.
Possible values include: 'Invalid', 'NotProtected', 'Protecting',
'Protected', 'ProtectionFailed'
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the backed up item. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional backupSetName
backupSetName:undefined | string
member
{string} [backupSetName] Name of the backup set the backup item
belongs to
{CreateMode} [createMode] Create mode to indicate recovery of
existing soft deleted data source or creation of new data source. Possible
values include: 'Invalid', 'Default', 'Recover'
{ProtectedItemHealthStatus} [protectedItemHealthStatus] Health
status of the backup item, evaluated based on last heartbeat received.
Possible values include: 'Invalid', 'Healthy', 'Unhealthy',
'NotReachable', 'IRPending'
{ProtectionState} [protectionState] Backup state of this backup
item. Possible values include: 'Invalid', 'IRPending', 'Protected',
'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'
Optional protectionStatus
protectionStatus:undefined | string
member
{string} [protectionStatus] Backup status of this backup item.
An interface representing AzureVmWorkloadSAPHanaDatabaseProtectableItem.
Azure VM workload-specific protectable item representing SAP Hana Database.
Optional backupManagementType
backupManagementType:undefined | string
member
{string} [backupManagementType] Type of backup managemenent to
backup an item.
Optional friendlyName
friendlyName:undefined | string
member
{string} [friendlyName] Friendly name of the backup item.
Optional isAutoProtectable
isAutoProtectable:undefined | false | true
member
{boolean} [isAutoProtectable] Indicates if protectable item is
auto-protectable
Optional isAutoProtected
isAutoProtected:undefined | false | true
member
{boolean} [isAutoProtected] Indicates if protectable item is
auto-protected
Optional parentName
parentName:undefined | string
member
{string} [parentName] Name for instance or AG
Optional parentUniqueName
parentUniqueName:undefined | string
member
{string} [parentUniqueName] Parent Unique Name is added to provide
the service formatted URI Name of the Parent
Only Applicable for data bases where the parent would be either Instance
or a SQL AG.
{ProtectionStatus} [protectionState] State of the back up item.
Possible values include: 'Invalid', 'NotProtected', 'Protecting',
'Protected', 'ProtectionFailed'
serializedName
serializedName:string = "SAPHanaDatabase"
Optional serverName
serverName:undefined | string
member
{string} [serverName] Host/Cluster Name for instance or AG
Optional subinquireditemcount
subinquireditemcount:undefined | number
member
{number} [subinquireditemcount] For instance or AG, indicates
number of DB's present
Optional subprotectableitemcount
subprotectableitemcount:undefined | number
member
{number} [subprotectableitemcount] For instance or AG, indicates
number of DB's to be protected
Optional workloadType
workloadType:undefined | string
member
{string} [workloadType] Type of workload for the backup management
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the backed up item. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional backupSetName
backupSetName:undefined | string
member
{string} [backupSetName] Name of the backup set the backup item
belongs to
{CreateMode} [createMode] Create mode to indicate recovery of
existing soft deleted data source or creation of new data source. Possible
values include: 'Invalid', 'Default', 'Recover'
{ProtectedItemHealthStatus} [protectedItemHealthStatus] Health
status of the backup item, evaluated based on last heartbeat received.
Possible values include: 'Invalid', 'Healthy', 'Unhealthy',
'NotReachable', 'IRPending'
{ProtectionState} [protectionState] Backup state of this backup
item. Possible values include: 'Invalid', 'IRPending', 'Protected',
'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'
Optional protectionStatus
protectionStatus:undefined | string
member
{string} [protectionStatus] Backup status of this backup item.
{ProtectionStatus} [protectionState] State of the back up item.
Possible values include: 'Invalid', 'NotProtected', 'Protecting',
'Protected', 'ProtectionFailed'
serializedName
serializedName:string = "SAPHanaDatabase"
Optional serverName
serverName:undefined | string
member
{string} [serverName] Host/Cluster Name for instance or AG
Optional subWorkloadItemCount
subWorkloadItemCount:undefined | number
member
{number} [subWorkloadItemCount] For instance or AG, indicates
number of DB's to be protected
Optional subinquireditemcount
subinquireditemcount:undefined | number
member
{number} [subinquireditemcount] For instance or AG, indicates
number of DB's present
An interface representing AzureVmWorkloadSAPHanaSystemProtectableItem.
Azure VM workload-specific protectable item representing SAP Hana System.
Optional backupManagementType
backupManagementType:undefined | string
member
{string} [backupManagementType] Type of backup managemenent to
backup an item.
Optional friendlyName
friendlyName:undefined | string
member
{string} [friendlyName] Friendly name of the backup item.
Optional isAutoProtectable
isAutoProtectable:undefined | false | true
member
{boolean} [isAutoProtectable] Indicates if protectable item is
auto-protectable
Optional isAutoProtected
isAutoProtected:undefined | false | true
member
{boolean} [isAutoProtected] Indicates if protectable item is
auto-protected
Optional parentName
parentName:undefined | string
member
{string} [parentName] Name for instance or AG
Optional parentUniqueName
parentUniqueName:undefined | string
member
{string} [parentUniqueName] Parent Unique Name is added to provide
the service formatted URI Name of the Parent
Only Applicable for data bases where the parent would be either Instance
or a SQL AG.
{ProtectionStatus} [protectionState] State of the back up item.
Possible values include: 'Invalid', 'NotProtected', 'Protecting',
'Protected', 'ProtectionFailed'
serializedName
serializedName:string = "SAPHanaSystem"
Optional serverName
serverName:undefined | string
member
{string} [serverName] Host/Cluster Name for instance or AG
Optional subinquireditemcount
subinquireditemcount:undefined | number
member
{number} [subinquireditemcount] For instance or AG, indicates
number of DB's present
Optional subprotectableitemcount
subprotectableitemcount:undefined | number
member
{number} [subprotectableitemcount] For instance or AG, indicates
number of DB's to be protected
Optional workloadType
workloadType:undefined | string
member
{string} [workloadType] Type of workload for the backup management
{ProtectionStatus} [protectionState] State of the back up item.
Possible values include: 'Invalid', 'NotProtected', 'Protecting',
'Protected', 'ProtectionFailed'
serializedName
serializedName:string = "SAPHanaSystem"
Optional serverName
serverName:undefined | string
member
{string} [serverName] Host/Cluster Name for instance or AG
Optional subWorkloadItemCount
subWorkloadItemCount:undefined | number
member
{number} [subWorkloadItemCount] For instance or AG, indicates
number of DB's to be protected
Optional subinquireditemcount
subinquireditemcount:undefined | number
member
{number} [subinquireditemcount] For instance or AG, indicates
number of DB's present
An interface representing AzureVmWorkloadSQLAvailabilityGroupProtectableItem.
Azure VM workload-specific protectable item representing SQL Availability
Group.
Optional backupManagementType
backupManagementType:undefined | string
member
{string} [backupManagementType] Type of backup managemenent to
backup an item.
Optional friendlyName
friendlyName:undefined | string
member
{string} [friendlyName] Friendly name of the backup item.
Optional isAutoProtectable
isAutoProtectable:undefined | false | true
member
{boolean} [isAutoProtectable] Indicates if protectable item is
auto-protectable
Optional isAutoProtected
isAutoProtected:undefined | false | true
member
{boolean} [isAutoProtected] Indicates if protectable item is
auto-protected
Optional parentName
parentName:undefined | string
member
{string} [parentName] Name for instance or AG
Optional parentUniqueName
parentUniqueName:undefined | string
member
{string} [parentUniqueName] Parent Unique Name is added to provide
the service formatted URI Name of the Parent
Only Applicable for data bases where the parent would be either Instance
or a SQL AG.
{ProtectionStatus} [protectionState] State of the back up item.
Possible values include: 'Invalid', 'NotProtected', 'Protecting',
'Protected', 'ProtectionFailed'
An interface representing AzureVmWorkloadSQLDatabaseProtectableItem.
Azure VM workload-specific protectable item representing SQL Database.
Optional backupManagementType
backupManagementType:undefined | string
member
{string} [backupManagementType] Type of backup managemenent to
backup an item.
Optional friendlyName
friendlyName:undefined | string
member
{string} [friendlyName] Friendly name of the backup item.
Optional isAutoProtectable
isAutoProtectable:undefined | false | true
member
{boolean} [isAutoProtectable] Indicates if protectable item is
auto-protectable
Optional isAutoProtected
isAutoProtected:undefined | false | true
member
{boolean} [isAutoProtected] Indicates if protectable item is
auto-protected
Optional parentName
parentName:undefined | string
member
{string} [parentName] Name for instance or AG
Optional parentUniqueName
parentUniqueName:undefined | string
member
{string} [parentUniqueName] Parent Unique Name is added to provide
the service formatted URI Name of the Parent
Only Applicable for data bases where the parent would be either Instance
or a SQL AG.
{ProtectionStatus} [protectionState] State of the back up item.
Possible values include: 'Invalid', 'NotProtected', 'Protecting',
'Protected', 'ProtectionFailed'
serializedName
serializedName:string = "SQLDataBase"
Optional serverName
serverName:undefined | string
member
{string} [serverName] Host/Cluster Name for instance or AG
Optional subinquireditemcount
subinquireditemcount:undefined | number
member
{number} [subinquireditemcount] For instance or AG, indicates
number of DB's present
Optional subprotectableitemcount
subprotectableitemcount:undefined | number
member
{number} [subprotectableitemcount] For instance or AG, indicates
number of DB's to be protected
Optional workloadType
workloadType:undefined | string
member
{string} [workloadType] Type of workload for the backup management
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the backed up item. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional backupSetName
backupSetName:undefined | string
member
{string} [backupSetName] Name of the backup set the backup item
belongs to
{CreateMode} [createMode] Create mode to indicate recovery of
existing soft deleted data source or creation of new data source. Possible
values include: 'Invalid', 'Default', 'Recover'
{ProtectedItemHealthStatus} [protectedItemHealthStatus] Health
status of the backup item, evaluated based on last heartbeat received.
Possible values include: 'Invalid', 'Healthy', 'Unhealthy',
'NotReachable', 'IRPending'
{ProtectionState} [protectionState] Backup state of this backup
item. Possible values include: 'Invalid', 'IRPending', 'Protected',
'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'
Optional protectionStatus
protectionStatus:undefined | string
member
{string} [protectionStatus] Backup status of this backup item.
{ProtectionStatus} [protectionState] State of the back up item.
Possible values include: 'Invalid', 'NotProtected', 'Protecting',
'Protected', 'ProtectionFailed'
serializedName
serializedName:string = "SQLDataBase"
Optional serverName
serverName:undefined | string
member
{string} [serverName] Host/Cluster Name for instance or AG
Optional subWorkloadItemCount
subWorkloadItemCount:undefined | number
member
{number} [subWorkloadItemCount] For instance or AG, indicates
number of DB's to be protected
Optional subinquireditemcount
subinquireditemcount:undefined | number
member
{number} [subinquireditemcount] For instance or AG, indicates
number of DB's present
An interface representing AzureVmWorkloadSQLInstanceProtectableItem.
Azure VM workload-specific protectable item representing SQL Instance.
Optional backupManagementType
backupManagementType:undefined | string
member
{string} [backupManagementType] Type of backup managemenent to
backup an item.
Optional friendlyName
friendlyName:undefined | string
member
{string} [friendlyName] Friendly name of the backup item.
Optional isAutoProtectable
isAutoProtectable:undefined | false | true
member
{boolean} [isAutoProtectable] Indicates if protectable item is
auto-protectable
Optional isAutoProtected
isAutoProtected:undefined | false | true
member
{boolean} [isAutoProtected] Indicates if protectable item is
auto-protected
Optional parentName
parentName:undefined | string
member
{string} [parentName] Name for instance or AG
Optional parentUniqueName
parentUniqueName:undefined | string
member
{string} [parentUniqueName] Parent Unique Name is added to provide
the service formatted URI Name of the Parent
Only Applicable for data bases where the parent would be either Instance
or a SQL AG.
{ProtectionStatus} [protectionState] State of the back up item.
Possible values include: 'Invalid', 'NotProtected', 'Protecting',
'Protected', 'ProtectionFailed'
serializedName
serializedName:string = "SQLInstance"
Optional serverName
serverName:undefined | string
member
{string} [serverName] Host/Cluster Name for instance or AG
Optional subinquireditemcount
subinquireditemcount:undefined | number
member
{number} [subinquireditemcount] For instance or AG, indicates
number of DB's present
Optional subprotectableitemcount
subprotectableitemcount:undefined | number
member
{number} [subprotectableitemcount] For instance or AG, indicates
number of DB's to be protected
Optional workloadType
workloadType:undefined | string
member
{string} [workloadType] Type of workload for the backup management
{ProtectionStatus} [protectionState] State of the back up item.
Possible values include: 'Invalid', 'NotProtected', 'Protecting',
'Protected', 'ProtectionFailed'
serializedName
serializedName:string = "SQLInstance"
Optional serverName
serverName:undefined | string
member
{string} [serverName] Host/Cluster Name for instance or AG
Optional subWorkloadItemCount
subWorkloadItemCount:undefined | number
member
{number} [subWorkloadItemCount] For instance or AG, indicates
number of DB's to be protected
Optional subinquireditemcount
subinquireditemcount:undefined | number
member
{number} [subinquireditemcount] For instance or AG, indicates
number of DB's present
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the backed up item. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional itemId
itemId:undefined | string
member
{string} [itemId] ID of the item which is getting protected, In
case of Azure Vm , it is ProtectedItemId
Optional policyId
policyId:undefined | string
member
{string} [policyId] ID of the backup policy with which this item
is backed up.
{ProtectionStatus} [protectionState] Backup state of this backup
item. Possible values include: 'Invalid', 'NotProtected', 'Protecting',
'Protected', 'ProtectionFailed'
{BackupType} [backupType] Type of backup, viz. Full, Differential,
Log or CopyOnlyFull. Possible values include: 'Invalid', 'Full',
'Differential', 'Log', 'CopyOnlyFull'
Optional enableCompression
enableCompression:undefined | false | true
member
{boolean} [enableCompression] Bool for Compression setting
objectType
objectType:"AzureWorkloadBackupRequest"
member
{string} objectType Polymorphic Discriminator
Optional recoveryPointExpiryTimeInUTC
recoveryPointExpiryTimeInUTC:Date
member
{Date} [recoveryPointExpiryTimeInUTC] Backup copy will expire
after the time specified (UTC).
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the container. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
{BackupManagementType} [backupManagementType] Backup management
type to execute the current job. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional duration
duration:undefined | string
member
{string} [duration] Time elapsed during the execution of this job.
Optional endTime
endTime:Date
member
{Date} [endTime] The end time.
Optional entityFriendlyName
entityFriendlyName:undefined | string
member
{string} [entityFriendlyName] Friendly name of the entity on which
the current job is executing.
Optional errorDetails
errorDetails:AzureWorkloadErrorInfo[]
member
{AzureWorkloadErrorInfo[]} [errorDetails] Error details on
execution of this job.
An interface representing AzureWorkloadSAPHanaPointInTimeRestoreRequest.
AzureWorkload SAP Hana -specific restore. Specifically for PointInTime/Log
restore
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the backed up item. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional itemId
itemId:undefined | string
member
{string} [itemId] ID of the item which is getting protected, In
case of Azure Vm , it is ProtectedItemId
Optional policyId
policyId:undefined | string
member
{string} [policyId] ID of the backup policy with which this item
is backed up.
{ProtectionStatus} [protectionState] Backup state of this backup
item. Possible values include: 'Invalid', 'NotProtected', 'Protecting',
'Protected', 'ProtectionFailed'
{WorkloadItemType} [workloadItemType] Workload item type of the
item for which intent is to be set. Possible values include: 'Invalid',
'SQLInstance', 'SQLDataBase', 'SAPHanaSystem', 'SAPHanaDatabase'
{AzureWorkloadSQLRecoveryPointExtendedInfo} [extendedInfo]
Extended Info that provides data directory details. Will be populated in
two cases:
When a specific recovery point is accessed using GetRecoveryPoint
Or when ListRecoveryPoints is called for Log RP only with ExtendedInfo
query filter
An interface representing AzureWorkloadSQLRecoveryPoint.
SQL specific recoverypoint, specifcally encaspulates full/diff recoverypoint
alongwith extended info
{AzureWorkloadSQLRecoveryPointExtendedInfo} [extendedInfo]
Extended Info that provides data directory details. Will be populated in
two cases:
When a specific recovery point is accessed using GetRecoveryPoint
Or when ListRecoveryPoints is called for Log RP only with ExtendedInfo
query filter
objectType
objectType:"AzureWorkloadSQLRecoveryPoint"
member
{string} objectType Polymorphic Discriminator
Optional recoveryPointTimeInUTC
recoveryPointTimeInUTC:Date
member
{Date} [recoveryPointTimeInUTC] UTC time at which recoverypoint
was created
{Type} [type] Backup management type for this container. Possible
values include: 'Invalid', 'BackupProtectedItemCountSummary',
'BackupProtectionContainerCountSummary'
{BackupManagementType} backupManagementType Backup management type
for this container. Possible values include: 'Invalid', 'AzureIaasVM',
'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage',
'AzureWorkload', 'DefaultBackup'
{BackupManagementType} [backupManagementType] Backup management
type for this container. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
{BackupManagementType} [backupManagementType] Backup management
type for this container. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
{BackupManagementType} [backupManagementType] Type of backup
management for the backup engine. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional canReRegister
canReRegister:undefined | false | true
member
{boolean} [canReRegister] Flag indicating if the backup engine be
registered, once already registered.
An interface representing BackupEngineBaseResource.
The base backup engine class. All workload specific backup engines derive
from this class.
extends
Resource
Optional eTag
eTag:undefined | string
member
{string} [eTag] Optional ETag.
Optional id
id:undefined | string
member
{string} [id] Resource Id represents the complete path to the
resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Optional location
location:undefined | string
member
{string} [location] Resource location.
Optional name
name:undefined | string
member
{string} [name] Resource name associated with the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Determines whether all the members of an array satisfy the specified test.
Parameters
callbackfn: function
A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Returns the value of the first element in the array where predicate is true, and undefined
otherwise.
Type parameters
S: BackupEngineBaseResource
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found, find
immediately returns that element value. Otherwise, find returns undefined.
findIndex(predicate: function, thisArg?: any): number
Returns the index of the first element in the array where predicate is true, and -1
otherwise.
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found,
findIndex immediately returns that element index. Otherwise, findIndex returns -1.
reduce<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: BackupEngineBaseResource, currentIndex: number, array: BackupEngineBaseResource[]): U
Parameters
previousValue: U
currentValue: BackupEngineBaseResource
currentIndex: number
array: BackupEngineBaseResource[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
reduceRight<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: BackupEngineBaseResource, currentIndex: number, array: BackupEngineBaseResource[]): U
Parameters
previousValue: U
currentValue: BackupEngineBaseResource
currentIndex: number
array: BackupEngineBaseResource[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U
reverse
reverse(): BackupEngineBaseResource[]
Reverses the elements in an Array.
Returns BackupEngineBaseResource[]
shift
shift(): BackupEngineBaseResource | undefined
Removes the first element from an array and returns it.
Determines whether the specified callback function returns true for any element of an array.
Parameters
callbackfn: function
A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Determines whether all the members of an array satisfy the specified test.
Parameters
callbackfn: function
A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Returns the value of the first element in the array where predicate is true, and undefined
otherwise.
Type parameters
S: BackupManagementUsage
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found, find
immediately returns that element value. Otherwise, find returns undefined.
findIndex(predicate: function, thisArg?: any): number
Returns the index of the first element in the array where predicate is true, and -1
otherwise.
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found,
findIndex immediately returns that element index. Otherwise, findIndex returns -1.
reduce<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: BackupManagementUsage, currentIndex: number, array: BackupManagementUsage[]): U
Parameters
previousValue: U
currentValue: BackupManagementUsage
currentIndex: number
array: BackupManagementUsage[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
reduceRight<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: BackupManagementUsage, currentIndex: number, array: BackupManagementUsage[]): U
Parameters
previousValue: U
currentValue: BackupManagementUsage
currentIndex: number
array: BackupManagementUsage[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U
reverse
reverse(): BackupManagementUsage[]
Reverses the elements in an Array.
Returns BackupManagementUsage[]
shift
shift(): BackupManagementUsage | undefined
Removes the first element from an array and returns it.
Determines whether the specified callback function returns true for any element of an array.
Parameters
callbackfn: function
A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
Parameters
start: number
The zero-based location in the array from which to start removing elements.
Optional deleteCount: undefined | number
The number of elements to remove.
Returns BackupManagementUsage[]
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
Parameters
start: number
The zero-based location in the array from which to start removing elements.
deleteCount: number
The number of elements to remove.
Rest...items: BackupManagementUsage[]
Elements to insert into the array in place of the deleted elements.
Returns BackupManagementUsage[]
toLocaleString
toLocaleString(): string
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.
Returns string
toString
toString(): string
Returns a string representation of an array.
Returns string
unshift
unshift(...items: BackupManagementUsage[]): number
Inserts new elements at the start of an array.
Parameters
Rest...items: BackupManagementUsage[]
Elements to insert at the start of the Array.
Returns number
values
values(): IterableIterator<BackupManagementUsage>
Returns an iterable of values in the array
Returns IterableIterator<BackupManagementUsage>
type
type:object
className
className:string = "BackupManagementUsageList"
name
name:"Composite" = "Composite"
modelProperties
modelProperties:object
value
value:object
serializedName
serializedName:string = ""
type
type:object
name
name:"Sequence" = "Sequence"
element
element:object
type
type:object
className
className:string = "BackupManagementUsage"
name
name:"Composite" = "Composite"
Const BackupRequest
BackupRequest:object
interface
An interface representing BackupRequest.
Base class for backup request. Workload-specific backup requests are derived
from this class.
objectType
objectType:"BackupRequest"
member
{string} objectType Polymorphic Discriminator
serializedName
serializedName:string = "BackupRequest"
type
type:object
className
className:string = "BackupRequest"
name
name:"Composite" = "Composite"
uberParent
uberParent:string = "BackupRequest"
modelProperties
modelProperties:object
objectType
objectType:object
required
required:true = true
serializedName
serializedName:string = "objectType"
type
type:object
name
name:"String" = "String"
polymorphicDiscriminator
polymorphicDiscriminator:object
clientName
clientName:string = "objectType"
serializedName
serializedName:string = "objectType"
Const BackupRequestResource
BackupRequestResource:object
interface
An interface representing BackupRequestResource.
Base class for backup request. Workload-specific backup requests are derived
from this class.
extends
Resource
Optional eTag
eTag:undefined | string
member
{string} [eTag] Optional ETag.
Optional id
id:undefined | string
member
{string} [id] Resource Id represents the complete path to the
resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Optional location
location:undefined | string
member
{string} [location] Resource location.
Optional name
name:undefined | string
member
{string} [name] Resource name associated with the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
{StorageTypeState} [storageTypeState] Locked or Unlocked. Once a
machine is registered against a resource, the storageTypeState is always
Locked. Possible values include: 'Invalid', 'Locked', 'Unlocked'
type
type:object
className
className:string = "BackupResourceConfig"
name
name:"Composite" = "Composite"
modelProperties
modelProperties:object
storageModelType
storageModelType:object
serializedName
serializedName:string = "storageModelType"
type
type:object
name
name:"String" = "String"
storageType
storageType:object
serializedName
serializedName:string = "storageType"
type
type:object
name
name:"String" = "String"
storageTypeState
storageTypeState:object
serializedName
serializedName:string = "storageTypeState"
type
type:object
name
name:"String" = "String"
Const BackupResourceConfigResource
BackupResourceConfigResource:object
interface
An interface representing BackupResourceConfigResource.
The resource storage details.
extends
Resource
Optional eTag
eTag:undefined | string
member
{string} [eTag] Optional ETag.
Optional id
id:undefined | string
member
{string} [id] Resource Id represents the complete path to the
resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Optional location
location:undefined | string
member
{string} [location] Resource location.
Optional name
name:undefined | string
member
{string} [name] Resource name associated with the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
{StorageTypeState} [storageTypeState] Locked or Unlocked. Once a
machine is registered against a resource, the storageTypeState is always
Locked. Possible values include: 'Invalid', 'Locked', 'Unlocked'
type
type:object
className
className:string = "BackupResourceVaultConfig"
name
name:"Composite" = "Composite"
modelProperties
modelProperties:object
enhancedSecurityState
enhancedSecurityState:object
serializedName
serializedName:string = "enhancedSecurityState"
type
type:object
name
name:"String" = "String"
storageModelType
storageModelType:object
serializedName
serializedName:string = "storageModelType"
type
type:object
name
name:"String" = "String"
storageType
storageType:object
serializedName
serializedName:string = "storageType"
type
type:object
name
name:"String" = "String"
storageTypeState
storageTypeState:object
serializedName
serializedName:string = "storageTypeState"
type
type:object
name
name:"String" = "String"
Const BackupResourceVaultConfigResource
BackupResourceVaultConfigResource:object
interface
An interface representing BackupResourceVaultConfigResource.
Backup resource vault config details.
extends
Resource
Optional eTag
eTag:undefined | string
member
{string} [eTag] Optional ETag.
Optional id
id:undefined | string
member
{string} [id] Resource Id represents the complete path to the
resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Optional location
location:undefined | string
member
{string} [location] Resource location.
Optional name
name:undefined | string
member
{string} [name] Resource name associated with the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
{ProtectionStatus} [protectionStatus] Specifies whether the
container is registered or not. Possible values include: 'Invalid',
'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'
Optional registrationStatus
registrationStatus:undefined | string
member
{string} [registrationStatus] Container registration status
serializedName
serializedName:string = "BackupStatusResponse"
type
type:object
className
className:string = "BackupStatusResponse"
name
name:"Composite" = "Composite"
modelProperties
modelProperties:object
containerName
containerName:object
serializedName
serializedName:string = "containerName"
type
type:object
name
name:"String" = "String"
errorCode
errorCode:object
serializedName
serializedName:string = "errorCode"
type
type:object
name
name:"String" = "String"
errorMessage
errorMessage:object
serializedName
serializedName:string = "errorMessage"
type
type:object
name
name:"String" = "String"
fabricName
fabricName:object
serializedName
serializedName:string = "fabricName"
type
type:object
name
name:"String" = "String"
policyName
policyName:object
serializedName
serializedName:string = "policyName"
type
type:object
name
name:"String" = "String"
protectedItemName
protectedItemName:object
serializedName
serializedName:string = "protectedItemName"
type
type:object
name
name:"String" = "String"
protectionStatus
protectionStatus:object
serializedName
serializedName:string = "protectionStatus"
type
type:object
name
name:"String" = "String"
registrationStatus
registrationStatus:object
serializedName
serializedName:string = "registrationStatus"
type
type:object
name
name:"String" = "String"
Const ClientDiscoveryDisplay
ClientDiscoveryDisplay:object
interface
An interface representing ClientDiscoveryDisplay.
Localized display information of an operation.
Optional description
description:undefined | string
member
{string} [description] Description of the operation having details
of what operation is about.
Optional operation
operation:undefined | string
member
{string} [operation] Operations Name itself.
Optional provider
provider:undefined | string
member
{string} [provider] Name of the provider for display purposes
Optional resource
resource:undefined | string
member
{string} [resource] ResourceType for which this Operation can be
performed.
serializedName
serializedName:string = "ClientDiscoveryDisplay"
type
type:object
className
className:string = "ClientDiscoveryDisplay"
name
name:"Composite" = "Composite"
modelProperties
modelProperties:object
description
description:object
serializedName
serializedName:string = "description"
type
type:object
name
name:"String" = "String"
operation
operation:object
serializedName
serializedName:string = "operation"
type
type:object
name
name:"String" = "String"
provider
provider:object
serializedName
serializedName:string = "provider"
type
type:object
name
name:"String" = "String"
resource
resource:object
serializedName
serializedName:string = "resource"
type
type:object
name
name:"String" = "String"
Const ClientDiscoveryForLogSpecification
ClientDiscoveryForLogSpecification:object
interface
An interface representing ClientDiscoveryForLogSpecification.
Class to represent shoebox log specification in json client discovery.
Optional blobDuration
blobDuration:undefined | string
member
{string} [blobDuration] blob duration of shoebox log specification
Optional displayName
displayName:undefined | string
member
{string} [displayName] Localized display name
Optional name
name:undefined | string
member
{string} [name] Name for shoebox log specification.
Determines whether all the members of an array satisfy the specified test.
Parameters
callbackfn: function
A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Returns the value of the first element in the array where predicate is true, and undefined
otherwise.
Type parameters
S: ClientDiscoveryValueForSingleApi
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found, find
immediately returns that element value. Otherwise, find returns undefined.
findIndex(predicate: function, thisArg?: any): number
Returns the index of the first element in the array where predicate is true, and -1
otherwise.
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found,
findIndex immediately returns that element index. Otherwise, findIndex returns -1.
reduce<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: ClientDiscoveryValueForSingleApi, currentIndex: number, array: ClientDiscoveryValueForSingleApi[]): U
Parameters
previousValue: U
currentValue: ClientDiscoveryValueForSingleApi
currentIndex: number
array: ClientDiscoveryValueForSingleApi[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
reduceRight<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: ClientDiscoveryValueForSingleApi, currentIndex: number, array: ClientDiscoveryValueForSingleApi[]): U
Parameters
previousValue: U
currentValue: ClientDiscoveryValueForSingleApi
currentIndex: number
array: ClientDiscoveryValueForSingleApi[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Determines whether the specified callback function returns true for any element of an array.
Parameters
callbackfn: function
A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
An interface representing ClientScriptForConnect.
Client script details for file / folder restore.
Optional osType
osType:undefined | string
member
{string} [osType] OS type - Windows, Linux etc. for which this
file / folder restore client script works.
Optional scriptContent
scriptContent:undefined | string
member
{string} [scriptContent] File content of the client script for
file / folder restore.
Optional scriptExtension
scriptExtension:undefined | string
member
{string} [scriptExtension] File extension of the client script for
file / folder restore - .ps1 , .sh , etc.
Optional scriptNameSuffix
scriptNameSuffix:undefined | string
member
{string} [scriptNameSuffix] Mandator suffix that should be added
to the name of script that is given for download to user.
If its null or empty then , ignore it.
serializedName
serializedName:string = "ClientScriptForConnect"
Optional url
url:undefined | string
member
{string} [url] URL of Executable from where to source the content.
If this is not null then ScriptContent should not be used
type
type:object
className
className:string = "ClientScriptForConnect"
name
name:"Composite" = "Composite"
modelProperties
modelProperties:object
osType
osType:object
serializedName
serializedName:string = "osType"
type
type:object
name
name:"String" = "String"
scriptContent
scriptContent:object
serializedName
serializedName:string = "scriptContent"
type
type:object
name
name:"String" = "String"
scriptExtension
scriptExtension:object
serializedName
serializedName:string = "scriptExtension"
type
type:object
name
name:"String" = "String"
scriptNameSuffix
scriptNameSuffix:object
serializedName
serializedName:string = "scriptNameSuffix"
type
type:object
name
name:"String" = "String"
url
url:object
serializedName
serializedName:string = "url"
type
type:object
name
name:"String" = "String"
Const ContainerIdentityInfo
ContainerIdentityInfo:object
interface
An interface representing ContainerIdentityInfo.
Container identity information
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the backed up item. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional backupSetName
backupSetName:undefined | string
member
{string} [backupSetName] Name of the backup set the backup item
belongs to
{CreateMode} [createMode] Create mode to indicate recovery of
existing soft deleted data source or creation of new data source. Possible
values include: 'Invalid', 'Default', 'Recover'
{ProtectedItemState} [protectionState] Protection state of the
backupengine. Possible values include: 'Invalid', 'IRPending',
'Protected', 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'
serializedName
serializedName:string = "DPMProtectedItem"
Optional sourceResourceId
sourceResourceId:undefined | string
member
{string} [sourceResourceId] ARM ID of the resource to be backed
up.
{BackupManagementType} [backupManagementType] Type of backup
management for the backup engine. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional canReRegister
canReRegister:undefined | false | true
member
{boolean} [canReRegister] Flag indicating if the backup engine be
registered, once already registered.
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the container. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional canReRegister
canReRegister:undefined | false | true
member
{boolean} [canReRegister] Specifies whether the container is
re-registrable.
Optional containerId
containerId:undefined | string
member
{string} [containerId] ID of container.
containerType
containerType:"DPMContainer"
member
{string} containerType Polymorphic Discriminator
Optional dpmAgentVersion
dpmAgentVersion:undefined | string
member
{string} [dpmAgentVersion] Backup engine Agent version
Optional dpmServers
dpmServers:string[]
member
{string[]} [dpmServers] List of BackupEngines protecting the
container
{BackupManagementType} [backupManagementType] Backup management
type to execute the current job. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional containerName
containerName:undefined | string
member
{string} [containerName] Name of cluster/server protecting current
backup item, if any.
Optional containerType
containerType:undefined | string
member
{string} [containerType] Type of container.
Optional dpmServerName
dpmServerName:undefined | string
member
{string} [dpmServerName] DPM server name managing the backup item
or backup job.
Optional duration
duration:undefined | string
member
{string} [duration] Time elapsed for job.
Optional endTime
endTime:Date
member
{Date} [endTime] The end time.
Optional entityFriendlyName
entityFriendlyName:undefined | string
member
{string} [entityFriendlyName] Friendly name of the entity on which
the current job is executing.
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the container. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the backed up item. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional backupSetName
backupSetName:undefined | string
member
{string} [backupSetName] Name of the backup set the backup item
belongs to
{CreateMode} [createMode] Create mode to indicate recovery of
existing soft deleted data source or creation of new data source. Possible
values include: 'Invalid', 'Default', 'Recover'
Optional fabricName
fabricName:undefined | string
member
{string} [fabricName] Name of this backup item's fabric.
Optional friendlyName
friendlyName:undefined | string
member
{string} [friendlyName] Friendly name of the container.
Optional lastRecoveryPoint
lastRecoveryPoint:Date
member
{Date} [lastRecoveryPoint] Timestamp when the last (latest) backup
copy was created for this backup item.
Optional policyId
policyId:undefined | string
member
{string} [policyId] ID of the backup policy with which this item
is backed up.
Optional policyState
policyState:undefined | string
member
{string} [policyState] Indicates consistency of policy object and
policy applied to this backup item.
Optional protectedItemId
protectedItemId:undefined | number
member
{number} [protectedItemId] Data Plane Service ID of the protected
item.
{ProtectionState} [protectionState] Backup state of this backup
item. Possible values include: 'Invalid', 'IRPending', 'Protected',
'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'
serializedName
serializedName:string = "GenericProtectedItem"
Optional sourceAssociations
sourceAssociations:undefined | object
member
{{ [propertyName: string]: string }} [sourceAssociations] Loosely
coupled (type, value) associations (example - parent of a protected item)
Optional sourceResourceId
sourceResourceId:undefined | string
member
{string} [sourceResourceId] ARM ID of the resource to be backed
up.
An interface representing ILRRequest.
Parameters to restore file/folders API.
objectType
objectType:"ILRRequest"
member
{string} objectType Polymorphic Discriminator
serializedName
serializedName:string = "ILRRequest"
type
type:object
className
className:string = "ILRRequest"
name
name:"Composite" = "Composite"
uberParent
uberParent:string = "ILRRequest"
modelProperties
modelProperties:object
objectType
objectType:object
required
required:true = true
serializedName
serializedName:string = "objectType"
type
type:object
name
name:"String" = "String"
polymorphicDiscriminator
polymorphicDiscriminator:object
clientName
clientName:string = "objectType"
serializedName
serializedName:string = "objectType"
Const ILRRequestResource
ILRRequestResource:object
interface
An interface representing ILRRequestResource.
Parameters to restore file/folders API.
extends
Resource
Optional eTag
eTag:undefined | string
member
{string} [eTag] Optional ETag.
Optional id
id:undefined | string
member
{string} [id] Resource Id represents the complete path to the
resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Optional location
location:undefined | string
member
{string} [location] Resource location.
Optional name
name:undefined | string
member
{string} [name] Resource name associated with the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the container. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
containerType
containerType:"IaaSVMContainer"
member
{string} containerType Polymorphic Discriminator
Optional friendlyName
friendlyName:undefined | string
member
{string} [friendlyName] Friendly name of the container.
Optional healthStatus
healthStatus:undefined | string
member
{string} [healthStatus] Status of health of the container.
Optional registrationStatus
registrationStatus:undefined | string
member
{string} [registrationStatus] Status of registration of the
container with the Recovery Services Vault.
Optional resourceGroup
resourceGroup:undefined | string
member
{string} [resourceGroup] Resource group name of Recovery Services
Vault.
serializedName
serializedName:string = "IaaSVMContainer"
Optional virtualMachineId
virtualMachineId:undefined | string
member
{string} [virtualMachineId] Fully qualified ARM url of the virtual
machine represented by this Azure IaaS VM container.
Optional virtualMachineVersion
virtualMachineVersion:undefined | string
member
{string} [virtualMachineVersion] Specifies whether the container
represents a Classic or an Azure Resource Manager VM.
{ProtectionStatus} [protectionState] State of the back up item.
Possible values include: 'Invalid', 'NotProtected', 'Protecting',
'Protected', 'ProtectionFailed'
serializedName
serializedName:string = "IaaSVMProtectableItem"
Optional virtualMachineId
virtualMachineId:undefined | string
member
{string} [virtualMachineId] Fully qualified ARM ID of the virtual
machine.
Optional workloadType
workloadType:undefined | string
member
{string} [workloadType] Type of workload for the backup management
An interface representing IaasVMRestoreRequest.
IaaS VM workload-specific restore.
Optional affinityGroup
affinityGroup:undefined | string
member
{string} [affinityGroup] Affinity group associated to VM to be
restored. Used only for Classic Compute Virtual Machines.
Optional createNewCloudService
createNewCloudService:undefined | false | true
member
{boolean} [createNewCloudService] Should a new cloud service be
created while restoring the VM. If this is false, VM will be restored to
the same
cloud service as it was at the time of backup.
{RecoveryType} [recoveryType] Type of this recovery. Possible
values include: 'Invalid', 'OriginalLocation', 'AlternateLocation',
'RestoreDisks'
Optional region
region:undefined | string
member
{string} [region] Region in which the virtual machine is restored.
serializedName
serializedName:string = "IaasVMRestoreRequest"
Optional sourceResourceId
sourceResourceId:undefined | string
member
{string} [sourceResourceId] Fully qualified ARM ID of the VM which
is being recovered.
Optional storageAccountId
storageAccountId:undefined | string
member
{string} [storageAccountId] Fully qualified ARM ID of the storage
account to which the VM has to be restored.
Optional subnetId
subnetId:undefined | string
member
{string} [subnetId] Subnet ID, is the subnet ID associated with
the to be restored VM. For Classic VMs it would be
{VnetID}/Subnet/{SubnetName} and, for the Azure Resource Manager VMs it
would be ARM resource ID used to represent
the subnet.
Optional targetDomainNameId
targetDomainNameId:undefined | string
member
{string} [targetDomainNameId] Fully qualified ARM ID of the domain
name to be associated to the VM being restored. This applies only to
Classic
Virtual Machines.
Optional targetResourceGroupId
targetResourceGroupId:undefined | string
member
{string} [targetResourceGroupId] This is the ARM Id of the
resource group that you want to create for this Virtual machine and other
artifacts.
For e.g. /subscriptions/{subId}/resourcegroups/{rg}
Optional targetVirtualMachineId
targetVirtualMachineId:undefined | string
member
{string} [targetVirtualMachineId] This is the complete ARM Id of
the VM that will be created.
For e.g.
/subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}
Optional virtualNetworkId
virtualNetworkId:undefined | string
member
{string} [virtualNetworkId] This is the virtual network Id of the
vnet that will be attached to the virtual machine.
User will be validated for join action permissions in the linked access.
{ErrorDetail} [errorDetail] Error Details if the Status is
non-success.
Optional inquiryDetails
inquiryDetails:WorkloadInquiryDetails[]
member
{WorkloadInquiryDetails[]} [inquiryDetails] Inquiry Details which
will have workload specific details.
For e.g. - For SQL and oracle this will contain different details.
serializedName
serializedName:string = "InquiryInfo"
Optional status
status:undefined | string
member
{string} [status] Inquiry Status for this container such as
InProgress | Failed | Succeeded
type
type:object
className
className:string = "InquiryInfo"
name
name:"Composite" = "Composite"
modelProperties
modelProperties:object
errorDetail
errorDetail:object
serializedName
serializedName:string = "errorDetail"
type
type:object
className
className:string = "ErrorDetail"
name
name:"Composite" = "Composite"
inquiryDetails
inquiryDetails:object
serializedName
serializedName:string = "inquiryDetails"
type
type:object
name
name:"Sequence" = "Sequence"
element
element:object
type
type:object
className
className:string = "WorkloadInquiryDetails"
name
name:"Composite" = "Composite"
status
status:object
serializedName
serializedName:string = "status"
type
type:object
name
name:"String" = "String"
Const InquiryValidation
InquiryValidation:object
interface
An interface representing InquiryValidation.
Validation for inquired protectable items under a given container.
{BackupManagementType} [backupManagementType] Backup management
type to execute the current job. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional endTime
endTime:Date
member
{Date} [endTime] The end time.
Optional entityFriendlyName
entityFriendlyName:undefined | string
member
{string} [entityFriendlyName] Friendly name of the entity on which
the current job is executing.
jobType
jobType:"Job"
member
{string} jobType Polymorphic Discriminator
Optional operation
operation:undefined | string
member
{string} [operation] The operation name.
serializedName
serializedName:string = "Job"
Optional startTime
startTime:Date
member
{Date} [startTime] The start time.
Optional status
status:undefined | string
member
{string} [status] Job status.
type
type:object
className
className:string = "Job"
name
name:"Composite" = "Composite"
uberParent
uberParent:string = "Job"
modelProperties
modelProperties:object
activityId
activityId:object
serializedName
serializedName:string = "activityId"
type
type:object
name
name:"String" = "String"
backupManagementType
backupManagementType:object
serializedName
serializedName:string = "backupManagementType"
type
type:object
name
name:"String" = "String"
endTime
endTime:object
serializedName
serializedName:string = "endTime"
type
type:object
name
name:"DateTime" = "DateTime"
entityFriendlyName
entityFriendlyName:object
serializedName
serializedName:string = "entityFriendlyName"
type
type:object
name
name:"String" = "String"
jobType
jobType:object
required
required:true = true
serializedName
serializedName:string = "jobType"
type
type:object
name
name:"String" = "String"
operation
operation:object
serializedName
serializedName:string = "operation"
type
type:object
name
name:"String" = "String"
startTime
startTime:object
serializedName
serializedName:string = "startTime"
type
type:object
name
name:"DateTime" = "DateTime"
status
status:object
serializedName
serializedName:string = "status"
type
type:object
name
name:"String" = "String"
polymorphicDiscriminator
polymorphicDiscriminator:object
clientName
clientName:string = "jobType"
serializedName
serializedName:string = "jobType"
Const JobQueryObject
JobQueryObject:object
interface
An interface representing JobQueryObject.
Filters to list the jobs.
{BackupManagementType} [backupManagementType] Type of backup
managmenent for the job. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional endTime
endTime:Date
member
{Date} [endTime] Job has ended at this time. Value is in UTC.
Optional jobId
jobId:undefined | string
member
{string} [jobId] JobID represents the job uniquely.
{JobStatus} [status] Status of the job. Possible values include:
'Invalid', 'InProgress', 'Completed', 'Failed', 'CompletedWithWarnings',
'Cancelled', 'Cancelling'
type
type:object
className
className:string = "JobQueryObject"
name
name:"Composite" = "Composite"
modelProperties
modelProperties:object
backupManagementType
backupManagementType:object
serializedName
serializedName:string = "backupManagementType"
type
type:object
name
name:"String" = "String"
endTime
endTime:object
serializedName
serializedName:string = "endTime"
type
type:object
name
name:"DateTime" = "DateTime"
jobId
jobId:object
serializedName
serializedName:string = "jobId"
type
type:object
name
name:"String" = "String"
operation
operation:object
serializedName
serializedName:string = "operation"
type
type:object
name
name:"String" = "String"
startTime
startTime:object
serializedName
serializedName:string = "startTime"
type
type:object
name
name:"DateTime" = "DateTime"
status
status:object
serializedName
serializedName:string = "status"
type
type:object
name
name:"String" = "String"
Const JobResource
JobResource:object
interface
An interface representing JobResource.
Defines workload agnostic properties for a job.
extends
Resource
Optional eTag
eTag:undefined | string
member
{string} [eTag] Optional ETag.
Optional id
id:undefined | string
member
{string} [id] Resource Id represents the complete path to the
resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Optional location
location:undefined | string
member
{string} [location] Resource location.
Optional name
name:undefined | string
member
{string} [name] Resource name associated with the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Determines whether all the members of an array satisfy the specified test.
Parameters
callbackfn: function
A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Returns the value of the first element in the array where predicate is true, and undefined
otherwise.
Type parameters
S: JobResource
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found, find
immediately returns that element value. Otherwise, find returns undefined.
findIndex(predicate: function, thisArg?: any): number
Returns the index of the first element in the array where predicate is true, and -1
otherwise.
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found,
findIndex immediately returns that element index. Otherwise, findIndex returns -1.
reduce<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: JobResource, currentIndex: number, array: JobResource[]): U
Parameters
previousValue: U
currentValue: JobResource
currentIndex: number
array: JobResource[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
reduceRight<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: JobResource, currentIndex: number, array: JobResource[]): U
Parameters
previousValue: U
currentValue: JobResource
currentIndex: number
array: JobResource[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U
reverse
reverse(): JobResource[]
Reverses the elements in an Array.
Returns JobResource[]
shift
shift(): JobResource | undefined
Removes the first element from an array and returns it.
Determines whether the specified callback function returns true for any element of an array.
Parameters
callbackfn: function
A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
Parameters
start: number
The zero-based location in the array from which to start removing elements.
Optional deleteCount: undefined | number
The number of elements to remove.
Returns JobResource[]
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
Parameters
start: number
The zero-based location in the array from which to start removing elements.
deleteCount: number
The number of elements to remove.
Rest...items: JobResource[]
Elements to insert into the array in place of the deleted elements.
Returns JobResource[]
toLocaleString
toLocaleString(): string
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.
Returns string
toString
toString(): string
Returns a string representation of an array.
Returns string
unshift
unshift(...items: JobResource[]): number
Inserts new elements at the start of an array.
Parameters
Rest...items: JobResource[]
Elements to insert at the start of the Array.
Returns number
values
values(): IterableIterator<JobResource>
Returns an iterable of values in the array
Returns IterableIterator<JobResource>
type
type:object
className
className:string = "JobResourceList"
name
name:"Composite" = "Composite"
modelProperties
modelProperties:object
value
value:object
serializedName
serializedName:string = ""
type
type:object
name
name:"Sequence" = "Sequence"
element
element:object
type
type:object
className
className:string = "JobResource"
name
name:"Composite" = "Composite"
Const KEKDetails
KEKDetails:object
interface
An interface representing KEKDetails.
KEK is encryption key for BEK.
Optional keyBackupData
keyBackupData:undefined | string
member
{string} [keyBackupData] KEK data.
Optional keyUrl
keyUrl:undefined | string
member
{string} [keyUrl] Key is KEK.
Optional keyVaultId
keyVaultId:undefined | string
member
{string} [keyVaultId] Key Vault ID where this Key is stored.
serializedName
serializedName:string = "KEKDetails"
type
type:object
className
className:string = "KEKDetails"
name
name:"Composite" = "Composite"
modelProperties
modelProperties:object
keyBackupData
keyBackupData:object
serializedName
serializedName:string = "keyBackupData"
type
type:object
name
name:"String" = "String"
keyUrl
keyUrl:object
serializedName
serializedName:string = "keyUrl"
type
type:object
name
name:"String" = "String"
keyVaultId
keyVaultId:object
serializedName
serializedName:string = "keyVaultId"
type
type:object
name
name:"String" = "String"
Const KeyAndSecretDetails
KeyAndSecretDetails:object
interface
An interface representing KeyAndSecretDetails.
BEK is bitlocker key.
KEK is encryption key for BEK
If the VM was encrypted then we will store follwing details :
Secret(BEK) - Url + Backup Data + vaultId.
Key(KEK) - Url + Backup Data + vaultId.
EncryptionMechanism
BEK and KEK can potentiallty have different vault ids.
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the container. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional canReRegister
canReRegister:undefined | false | true
member
{boolean} [canReRegister] Can the container be registered one more
time.
Optional containerHealthState
containerHealthState:undefined | string
member
{string} [containerHealthState] Health state of mab container.
Optional containerId
containerId:undefined | number
member
{number} [containerId] ContainerID represents the container.
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the backed up item. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional backupSetName
backupSetName:undefined | string
member
{string} [backupSetName] Name of the backup set the backup item
belongs to
Optional computerName
computerName:undefined | string
member
{string} [computerName] Name of the computer associated with this
backup item.
{CreateMode} [createMode] Create mode to indicate recovery of
existing soft deleted data source or creation of new data source. Possible
values include: 'Invalid', 'Default', 'Recover'
Optional deferredDeleteSyncTimeInUTC
deferredDeleteSyncTimeInUTC:undefined | number
member
{number} [deferredDeleteSyncTimeInUTC] Sync time for deferred
deletion.
{BackupManagementType} [backupManagementType] Backup management
type to execute the current job. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional duration
duration:undefined | string
member
{string} [duration] Time taken by job to run.
Optional endTime
endTime:Date
member
{Date} [endTime] The end time.
Optional entityFriendlyName
entityFriendlyName:undefined | string
member
{string} [entityFriendlyName] Friendly name of the entity on which
the current job is executing.
{MabServerType} [mabServerType] Server type of MAB container.
Possible values include: 'Invalid', 'Unknown', 'IaasVMContainer',
'IaasVMServiceContainer', 'DPMContainer', 'AzureBackupServerContainer',
'MABContainer', 'Cluster', 'AzureSqlContainer', 'Windows', 'VCenter',
'VMAppContainer', 'SQLAGWorkLoadContainer', 'StorageContainer',
'GenericContainer'
{RetentionScheduleFormat} [retentionScheduleFormatType] Retention
schedule format type for monthly retention policy. Possible values
include: 'Invalid', 'Daily', 'Weekly'
{InquiryStatus} [status] Status of protectable item, i.e.
InProgress,Succeeded,Failed. Possible values include: 'Invalid',
'Success', 'Failed'
type
type:object
className
className:string = "PreBackupValidation"
name
name:"Composite" = "Composite"
modelProperties
modelProperties:object
code
code:object
serializedName
serializedName:string = "code"
type
type:object
name
name:"String" = "String"
message
message:object
serializedName
serializedName:string = "message"
type
type:object
name
name:"String" = "String"
status
status:object
serializedName
serializedName:string = "status"
type
type:object
name
name:"String" = "String"
Const PreValidateEnableBackupRequest
PreValidateEnableBackupRequest:object
interface
An interface representing PreValidateEnableBackupRequest.
Contract to validate if backup can be enabled on the given resource in a
given vault and given configuration.
It will validate followings
Vault capacity
VM is already protected
Any VM related configuration passed in properties.
Optional properties
properties:undefined | string
member
{string} [properties] Configuration of VM if any needs to be
validated like OS type etc
An interface representing PreValidateEnableBackupResponse.
Response contract for enable backup validation request
Optional containerName
containerName:undefined | string
member
{string} [containerName] Specifies the product specific container
name. E.g. iaasvmcontainer;iaasvmcontainer;rgname;vmname. This is required
for portal
Optional errorCode
errorCode:undefined | string
member
{string} [errorCode] Response error code
Optional errorMessage
errorMessage:undefined | string
member
{string} [errorMessage] Response error message
Optional protectedItemName
protectedItemName:undefined | string
member
{string} [protectedItemName] Specifies the product specific ds
name. E.g. vm;iaasvmcontainer;rgname;vmname. This is required for portal
Optional recommendation
recommendation:undefined | string
member
{string} [recommendation] Recommended action for user
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the container. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional containerId
containerId:undefined | string
member
{string} [containerId] Fabric Id of the container such as ARM Id.
Optional friendlyName
friendlyName:undefined | string
member
{string} [friendlyName] Friendly name of the container.
Optional healthStatus
healthStatus:undefined | string
member
{string} [healthStatus] Status of health of the container.
An interface representing ProtectableContainerResource.
Protectable Container Class.
extends
Resource
Optional eTag
eTag:undefined | string
member
{string} [eTag] Optional ETag.
Optional id
id:undefined | string
member
{string} [id] Resource Id represents the complete path to the
resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Optional location
location:undefined | string
member
{string} [location] Resource location.
Optional name
name:undefined | string
member
{string} [name] Resource name associated with the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Determines whether all the members of an array satisfy the specified test.
Parameters
callbackfn: function
A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Returns the value of the first element in the array where predicate is true, and undefined
otherwise.
Type parameters
S: ProtectableContainerResource
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found, find
immediately returns that element value. Otherwise, find returns undefined.
findIndex(predicate: function, thisArg?: any): number
Returns the index of the first element in the array where predicate is true, and -1
otherwise.
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found,
findIndex immediately returns that element index. Otherwise, findIndex returns -1.
reduce<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: ProtectableContainerResource, currentIndex: number, array: ProtectableContainerResource[]): U
Parameters
previousValue: U
currentValue: ProtectableContainerResource
currentIndex: number
array: ProtectableContainerResource[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
reduceRight<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: ProtectableContainerResource, currentIndex: number, array: ProtectableContainerResource[]): U
Parameters
previousValue: U
currentValue: ProtectableContainerResource
currentIndex: number
array: ProtectableContainerResource[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U
reverse
reverse(): ProtectableContainerResource[]
Reverses the elements in an Array.
Returns ProtectableContainerResource[]
shift
shift(): ProtectableContainerResource | undefined
Removes the first element from an array and returns it.
Determines whether the specified callback function returns true for any element of an array.
Parameters
callbackfn: function
A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the backed up item. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional backupSetName
backupSetName:undefined | string
member
{string} [backupSetName] Name of the backup set the backup item
belongs to
{CreateMode} [createMode] Create mode to indicate recovery of
existing soft deleted data source or creation of new data source. Possible
values include: 'Invalid', 'Default', 'Recover'
Optional lastRecoveryPoint
lastRecoveryPoint:Date
member
{Date} [lastRecoveryPoint] Timestamp when the last (latest) backup
copy was created for this backup item.
Optional policyId
policyId:undefined | string
member
{string} [policyId] ID of the backup policy with which this item
is backed up.
{BackupManagementType} [backupManagementType] Backup management
type for the backed up item. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional backupSetName
backupSetName:undefined | string
member
{string} [backupSetName] Name of the backup set.
Optional containerName
containerName:undefined | string
member
{string} [containerName] Name of the container.
Optional fabricName
fabricName:undefined | string
member
{string} [fabricName] Name of the fabric.
Optional friendlyName
friendlyName:undefined | string
member
{string} [friendlyName] Friendly name of protected item
An interface representing ProtectedItemResource.
Base class for backup items.
extends
Resource
Optional eTag
eTag:undefined | string
member
{string} [eTag] Optional ETag.
Optional id
id:undefined | string
member
{string} [id] Resource Id represents the complete path to the
resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Optional location
location:undefined | string
member
{string} [location] Resource location.
Optional name
name:undefined | string
member
{string} [name] Resource name associated with the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Determines whether all the members of an array satisfy the specified test.
Parameters
callbackfn: function
A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Returns the value of the first element in the array where predicate is true, and undefined
otherwise.
Type parameters
S: ProtectedItemResource
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found, find
immediately returns that element value. Otherwise, find returns undefined.
findIndex(predicate: function, thisArg?: any): number
Returns the index of the first element in the array where predicate is true, and -1
otherwise.
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found,
findIndex immediately returns that element index. Otherwise, findIndex returns -1.
reduce<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: ProtectedItemResource, currentIndex: number, array: ProtectedItemResource[]): U
Parameters
previousValue: U
currentValue: ProtectedItemResource
currentIndex: number
array: ProtectedItemResource[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
reduceRight<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: ProtectedItemResource, currentIndex: number, array: ProtectedItemResource[]): U
Parameters
previousValue: U
currentValue: ProtectedItemResource
currentIndex: number
array: ProtectedItemResource[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U
reverse
reverse(): ProtectedItemResource[]
Reverses the elements in an Array.
Returns ProtectedItemResource[]
shift
shift(): ProtectedItemResource | undefined
Removes the first element from an array and returns it.
Determines whether the specified callback function returns true for any element of an array.
Parameters
callbackfn: function
A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
Parameters
start: number
The zero-based location in the array from which to start removing elements.
Optional deleteCount: undefined | number
The number of elements to remove.
Returns ProtectedItemResource[]
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
Parameters
start: number
The zero-based location in the array from which to start removing elements.
deleteCount: number
The number of elements to remove.
Rest...items: ProtectedItemResource[]
Elements to insert into the array in place of the deleted elements.
Returns ProtectedItemResource[]
toLocaleString
toLocaleString(): string
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.
Returns string
toString
toString(): string
Returns a string representation of an array.
Returns string
unshift
unshift(...items: ProtectedItemResource[]): number
Inserts new elements at the start of an array.
Parameters
Rest...items: ProtectedItemResource[]
Elements to insert at the start of the Array.
Returns number
values
values(): IterableIterator<ProtectedItemResource>
Returns an iterable of values in the array
Returns IterableIterator<ProtectedItemResource>
type
type:object
className
className:string = "ProtectedItemResourceList"
name
name:"Composite" = "Composite"
modelProperties
modelProperties:object
value
value:object
serializedName
serializedName:string = ""
type
type:object
name
name:"Sequence" = "Sequence"
element
element:object
type
type:object
className
className:string = "ProtectedItemResource"
name
name:"Composite" = "Composite"
Const ProtectionContainer
ProtectionContainer:object
interface
An interface representing ProtectionContainer.
Base class for container with backup items. Containers with specific
workloads are derived from this class.
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the container. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
containerType
containerType:"ProtectionContainer"
member
{string} containerType Polymorphic Discriminator
Optional friendlyName
friendlyName:undefined | string
member
{string} [friendlyName] Friendly name of the container.
Optional healthStatus
healthStatus:undefined | string
member
{string} [healthStatus] Status of health of the container.
Optional registrationStatus
registrationStatus:undefined | string
member
{string} [registrationStatus] Status of registration of the
container with the Recovery Services Vault.
serializedName
serializedName:string = "ProtectionContainer"
type
type:object
className
className:string = "ProtectionContainer"
name
name:"Composite" = "Composite"
uberParent
uberParent:string = "ProtectionContainer"
modelProperties
modelProperties:object
backupManagementType
backupManagementType:object
serializedName
serializedName:string = "backupManagementType"
type
type:object
name
name:"String" = "String"
containerType
containerType:object
required
required:true = true
serializedName
serializedName:string = "containerType"
type
type:object
name
name:"String" = "String"
friendlyName
friendlyName:object
serializedName
serializedName:string = "friendlyName"
type
type:object
name
name:"String" = "String"
healthStatus
healthStatus:object
serializedName
serializedName:string = "healthStatus"
type
type:object
name
name:"String" = "String"
registrationStatus
registrationStatus:object
serializedName
serializedName:string = "registrationStatus"
type
type:object
name
name:"String" = "String"
polymorphicDiscriminator
polymorphicDiscriminator:object
clientName
clientName:string = "containerType"
serializedName
serializedName:string = "containerType"
Const ProtectionContainerResource
ProtectionContainerResource:object
interface
An interface representing ProtectionContainerResource.
Base class for container with backup items. Containers with specific
workloads are derived from this class.
extends
Resource
Optional eTag
eTag:undefined | string
member
{string} [eTag] Optional ETag.
Optional id
id:undefined | string
member
{string} [id] Resource Id represents the complete path to the
resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Optional location
location:undefined | string
member
{string} [location] Resource location.
Optional name
name:undefined | string
member
{string} [name] Resource name associated with the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Determines whether all the members of an array satisfy the specified test.
Parameters
callbackfn: function
A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Returns the value of the first element in the array where predicate is true, and undefined
otherwise.
Type parameters
S: ProtectionContainerResource
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found, find
immediately returns that element value. Otherwise, find returns undefined.
findIndex(predicate: function, thisArg?: any): number
Returns the index of the first element in the array where predicate is true, and -1
otherwise.
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found,
findIndex immediately returns that element index. Otherwise, findIndex returns -1.
reduce<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: ProtectionContainerResource, currentIndex: number, array: ProtectionContainerResource[]): U
Parameters
previousValue: U
currentValue: ProtectionContainerResource
currentIndex: number
array: ProtectionContainerResource[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
reduceRight<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: ProtectionContainerResource, currentIndex: number, array: ProtectionContainerResource[]): U
Parameters
previousValue: U
currentValue: ProtectionContainerResource
currentIndex: number
array: ProtectionContainerResource[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U
reverse
reverse(): ProtectionContainerResource[]
Reverses the elements in an Array.
Returns ProtectionContainerResource[]
shift
shift(): ProtectionContainerResource | undefined
Removes the first element from an array and returns it.
Determines whether the specified callback function returns true for any element of an array.
Parameters
callbackfn: function
A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
{BackupManagementType} [backupManagementType] Type of backup
managemenent for the backed up item. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
Optional itemId
itemId:undefined | string
member
{string} [itemId] ID of the item which is getting protected, In
case of Azure Vm , it is ProtectedItemId
Optional policyId
policyId:undefined | string
member
{string} [policyId] ID of the backup policy with which this item
is backed up.
{ProtectionStatus} [protectionState] Backup state of this backup
item. Possible values include: 'Invalid', 'NotProtected', 'Protecting',
'Protected', 'ProtectionFailed'
serializedName
serializedName:string = "ProtectionIntent"
Optional sourceResourceId
sourceResourceId:undefined | string
member
{string} [sourceResourceId] ARM ID of the resource to be backed
up.
{BackupManagementType} [backupManagementType] Backup management
type for the backed up item. Possible values include: 'Invalid',
'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql',
'AzureStorage', 'AzureWorkload', 'DefaultBackup'
An interface representing ProtectionIntentResource.
Base class for backup ProtectionIntent.
extends
Resource
Optional eTag
eTag:undefined | string
member
{string} [eTag] Optional ETag.
Optional id
id:undefined | string
member
{string} [id] Resource Id represents the complete path to the
resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Optional location
location:undefined | string
member
{string} [location] Resource location.
Optional name
name:undefined | string
member
{string} [name] Resource name associated with the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Determines whether all the members of an array satisfy the specified test.
Parameters
callbackfn: function
A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Returns the value of the first element in the array where predicate is true, and undefined
otherwise.
Type parameters
S: ProtectionIntentResource
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found, find
immediately returns that element value. Otherwise, find returns undefined.
findIndex(predicate: function, thisArg?: any): number
Returns the index of the first element in the array where predicate is true, and -1
otherwise.
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found,
findIndex immediately returns that element index. Otherwise, findIndex returns -1.
reduce<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: ProtectionIntentResource, currentIndex: number, array: ProtectionIntentResource[]): U
Parameters
previousValue: U
currentValue: ProtectionIntentResource
currentIndex: number
array: ProtectionIntentResource[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
reduceRight<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: ProtectionIntentResource, currentIndex: number, array: ProtectionIntentResource[]): U
Parameters
previousValue: U
currentValue: ProtectionIntentResource
currentIndex: number
array: ProtectionIntentResource[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U
reverse
reverse(): ProtectionIntentResource[]
Reverses the elements in an Array.
Returns ProtectionIntentResource[]
shift
shift(): ProtectionIntentResource | undefined
Removes the first element from an array and returns it.
Determines whether the specified callback function returns true for any element of an array.
Parameters
callbackfn: function
A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
{WorkloadType} [workloadType] Workload type for the backup policy.
Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb',
'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client',
'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'
type
type:object
className
className:string = "ProtectionPolicyQueryObject"
name
name:"Composite" = "Composite"
modelProperties
modelProperties:object
backupManagementType
backupManagementType:object
serializedName
serializedName:string = "backupManagementType"
type
type:object
name
name:"String" = "String"
fabricName
fabricName:object
serializedName
serializedName:string = "fabricName"
type
type:object
name
name:"String" = "String"
workloadType
workloadType:object
serializedName
serializedName:string = "workloadType"
type
type:object
name
name:"String" = "String"
Const ProtectionPolicyResource
ProtectionPolicyResource:object
interface
An interface representing ProtectionPolicyResource.
Base class for backup policy. Workload-specific backup policies are derived
from this class.
extends
Resource
Optional eTag
eTag:undefined | string
member
{string} [eTag] Optional ETag.
Optional id
id:undefined | string
member
{string} [id] Resource Id represents the complete path to the
resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Optional location
location:undefined | string
member
{string} [location] Resource location.
Optional name
name:undefined | string
member
{string} [name] Resource name associated with the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Determines whether all the members of an array satisfy the specified test.
Parameters
callbackfn: function
A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Returns the value of the first element in the array where predicate is true, and undefined
otherwise.
Type parameters
S: ProtectionPolicyResource
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found, find
immediately returns that element value. Otherwise, find returns undefined.
findIndex(predicate: function, thisArg?: any): number
Returns the index of the first element in the array where predicate is true, and -1
otherwise.
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found,
findIndex immediately returns that element index. Otherwise, findIndex returns -1.
reduce<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: ProtectionPolicyResource, currentIndex: number, array: ProtectionPolicyResource[]): U
Parameters
previousValue: U
currentValue: ProtectionPolicyResource
currentIndex: number
array: ProtectionPolicyResource[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
reduceRight<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: ProtectionPolicyResource, currentIndex: number, array: ProtectionPolicyResource[]): U
Parameters
previousValue: U
currentValue: ProtectionPolicyResource
currentIndex: number
array: ProtectionPolicyResource[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U
reverse
reverse(): ProtectionPolicyResource[]
Reverses the elements in an Array.
Returns ProtectionPolicyResource[]
shift
shift(): ProtectionPolicyResource | undefined
Removes the first element from an array and returns it.
Determines whether the specified callback function returns true for any element of an array.
Parameters
callbackfn: function
A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
An interface representing RecoveryPoint.
Base class for backup copies. Workload-specific backup copies are derived
from this class.
objectType
objectType:"RecoveryPoint"
member
{string} objectType Polymorphic Discriminator
serializedName
serializedName:string = "RecoveryPoint"
type
type:object
className
className:string = "RecoveryPoint"
name
name:"Composite" = "Composite"
uberParent
uberParent:string = "RecoveryPoint"
modelProperties
modelProperties:object
objectType
objectType:object
required
required:true = true
serializedName
serializedName:string = "objectType"
type
type:object
name
name:"String" = "String"
polymorphicDiscriminator
polymorphicDiscriminator:object
clientName
clientName:string = "objectType"
serializedName
serializedName:string = "objectType"
Const RecoveryPointResource
RecoveryPointResource:object
interface
An interface representing RecoveryPointResource.
Base class for backup copies. Workload-specific backup copies are derived
from this class.
extends
Resource
Optional eTag
eTag:undefined | string
member
{string} [eTag] Optional ETag.
Optional id
id:undefined | string
member
{string} [id] Resource Id represents the complete path to the
resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Optional location
location:undefined | string
member
{string} [location] Resource location.
Optional name
name:undefined | string
member
{string} [name] Resource name associated with the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Determines whether all the members of an array satisfy the specified test.
Parameters
callbackfn: function
A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Returns the value of the first element in the array where predicate is true, and undefined
otherwise.
Type parameters
S: RecoveryPointResource
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found, find
immediately returns that element value. Otherwise, find returns undefined.
findIndex(predicate: function, thisArg?: any): number
Returns the index of the first element in the array where predicate is true, and -1
otherwise.
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found,
findIndex immediately returns that element index. Otherwise, findIndex returns -1.
reduce<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: RecoveryPointResource, currentIndex: number, array: RecoveryPointResource[]): U
Parameters
previousValue: U
currentValue: RecoveryPointResource
currentIndex: number
array: RecoveryPointResource[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
reduceRight<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: RecoveryPointResource, currentIndex: number, array: RecoveryPointResource[]): U
Parameters
previousValue: U
currentValue: RecoveryPointResource
currentIndex: number
array: RecoveryPointResource[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U
reverse
reverse(): RecoveryPointResource[]
Reverses the elements in an Array.
Returns RecoveryPointResource[]
shift
shift(): RecoveryPointResource | undefined
Removes the first element from an array and returns it.
Determines whether the specified callback function returns true for any element of an array.
Parameters
callbackfn: function
A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
{string} [id] Resource Id represents the complete path to the
resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Optional location
location:undefined | string
member
{string} [location] Resource location.
Optional name
name:undefined | string
member
{string} [name] Resource name associated with the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
{string} [type] Resource type represents the complete path of the
form Namespace/ResourceType/ResourceType/...
NOTE: This property will not be serialized. It can only be populated by
the server.
className
className:string = "Resource"
name
name:"Composite" = "Composite"
modelProperties
modelProperties:object
eTag
eTag:object
serializedName
serializedName:string = "eTag"
type
type:object
name
name:"String" = "String"
id
id:object
readOnly
readOnly:true = true
serializedName
serializedName:string = "id"
type
type:object
name
name:"String" = "String"
location
location:object
serializedName
serializedName:string = "location"
type
type:object
name
name:"String" = "String"
name
name:object
readOnly
readOnly:true = true
serializedName
serializedName:string = "name"
type
type:object
name
name:"String" = "String"
tags
tags:object
serializedName
serializedName:string = "tags"
type
type:object
name
name:"Dictionary" = "Dictionary"
value
value:object
type
type:object
name
name:"String" = "String"
type
type:object
readOnly
readOnly:true = true
serializedName
serializedName:string = "type"
type
type:object
name
name:"String" = "String"
Const ResourceList
ResourceList:object
interface
An interface representing ResourceList.
Base for all lists of resources.
Optional nextLink
nextLink:undefined | string
member
{string} [nextLink] The uri to fetch the next page of resources.
Call ListNext() fetches next page of resources.
serializedName
serializedName:string = "ResourceList"
type
type:object
className
className:string = "ResourceList"
name
name:"Composite" = "Composite"
modelProperties
modelProperties:object
nextLink
nextLink:object
serializedName
serializedName:string = "nextLink"
type
type:object
name
name:"String" = "String"
Const RestoreFileSpecs
RestoreFileSpecs:object
interface
An interface representing RestoreFileSpecs.
Restore file specs like file path, type and target folder path info.
Optional fileSpecType
fileSpecType:undefined | string
member
{string} [fileSpecType] Indicates what the Path variable stands
for
Optional path
path:undefined | string
member
{string} [path] Source File/Folder path
serializedName
serializedName:string = "RestoreFileSpecs"
Optional targetFolderPath
targetFolderPath:undefined | string
member
{string} [targetFolderPath] Destination folder path in target
FileShare
type
type:object
className
className:string = "RestoreFileSpecs"
name
name:"Composite" = "Composite"
modelProperties
modelProperties:object
fileSpecType
fileSpecType:object
serializedName
serializedName:string = "fileSpecType"
type
type:object
name
name:"String" = "String"
path
path:object
serializedName
serializedName:string = "path"
type
type:object
name
name:"String" = "String"
targetFolderPath
targetFolderPath:object
serializedName
serializedName:string = "targetFolderPath"
type
type:object
name
name:"String" = "String"
Const RestoreRequest
RestoreRequest:object
interface
An interface representing RestoreRequest.
Base class for restore request. Workload-specific restore requests are
derived from this class.
objectType
objectType:"RestoreRequest"
member
{string} objectType Polymorphic Discriminator
serializedName
serializedName:string = "RestoreRequest"
type
type:object
className
className:string = "RestoreRequest"
name
name:"Composite" = "Composite"
uberParent
uberParent:string = "RestoreRequest"
modelProperties
modelProperties:object
objectType
objectType:object
required
required:true = true
serializedName
serializedName:string = "objectType"
type
type:object
name
name:"String" = "String"
polymorphicDiscriminator
polymorphicDiscriminator:object
clientName
clientName:string = "objectType"
serializedName
serializedName:string = "objectType"
Const RestoreRequestResource
RestoreRequestResource:object
interface
An interface representing RestoreRequestResource.
Base class for restore request. Workload-specific restore requests are
derived from this class.
extends
Resource
Optional eTag
eTag:undefined | string
member
{string} [eTag] Optional ETag.
Optional id
id:undefined | string
member
{string} [id] Resource Id represents the complete path to the
resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Optional location
location:undefined | string
member
{string} [location] Resource location.
Optional name
name:undefined | string
member
{string} [name] Resource name associated with the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
An interface representing RetentionDuration.
Retention duration.
Optional count
count:undefined | number
member
{number} [count] Count of duration types. Retention duration is
obtained by the counting the duration type Count times.
For example, when Count = 3 and DurationType = Weeks, retention duration
will be three weeks.
An interface representing Settings.
Common settings field for backup management
Optional isCompression
isCompression:undefined | false | true
member
{boolean} [isCompression] Workload compression flag. This has been
added so that 'isSqlCompression'
will be deprecated once clients upgrade to consider this flag.
Optional issqlcompression
issqlcompression:undefined | false | true
member
{boolean} [issqlcompression] SQL compression flag
serializedName
serializedName:string = "Settings"
Optional timeZone
timeZone:undefined | string
member
{string} [timeZone] TimeZone optional input as string. For
example: TimeZone = "Pacific Standard Time".
type
type:object
className
className:string = "Settings"
name
name:"Composite" = "Composite"
modelProperties
modelProperties:object
isCompression
isCompression:object
serializedName
serializedName:string = "isCompression"
type
type:object
name
name:"Boolean" = "Boolean"
issqlcompression
issqlcompression:object
serializedName
serializedName:string = "issqlcompression"
type
type:object
name
name:"Boolean" = "Boolean"
timeZone
timeZone:object
serializedName
serializedName:string = "timeZone"
type
type:object
name
name:"String" = "String"
Const SimpleRetentionPolicy
SimpleRetentionPolicy:object
interface
An interface representing SimpleRetentionPolicy.
Simple policy retention.
{OverwriteOptions} [overwriteOption] Can Overwrite if Target
DataBase already exists. Possible values include: 'Invalid',
'FailOnConflict', 'Overwrite'
serializedName
serializedName:string = "TargetRestoreInfo"
type
type:object
className
className:string = "TargetRestoreInfo"
name
name:"Composite" = "Composite"
modelProperties
modelProperties:object
containerId
containerId:object
serializedName
serializedName:string = "containerId"
type
type:object
name
name:"String" = "String"
databaseName
databaseName:object
serializedName
serializedName:string = "databaseName"
type
type:object
name
name:"String" = "String"
overwriteOption
overwriteOption:object
serializedName
serializedName:string = "overwriteOption"
type
type:object
name
name:"String" = "String"
Const TokenInformation
TokenInformation:object
interface
An interface representing TokenInformation.
The token information details.
Optional expiryTimeInUtcTicks
expiryTimeInUtcTicks:undefined | number
member
{number} [expiryTimeInUtcTicks] Expiry time of token.
Optional securityPIN
securityPIN:undefined | string
member
{string} [securityPIN] Security PIN
serializedName
serializedName:string = "TokenInformation"
Optional token
token:undefined | string
member
{string} [token] Token value.
type
type:object
className
className:string = "TokenInformation"
name
name:"Composite" = "Composite"
modelProperties
modelProperties:object
expiryTimeInUtcTicks
expiryTimeInUtcTicks:object
serializedName
serializedName:string = "expiryTimeInUtcTicks"
type
type:object
name
name:"Number" = "Number"
securityPIN
securityPIN:object
serializedName
serializedName:string = "securityPIN"
type
type:object
name
name:"String" = "String"
token
token:object
serializedName
serializedName:string = "token"
type
type:object
name
name:"String" = "String"
Const ValidateIaasVMRestoreOperationRequest
ValidateIaasVMRestoreOperationRequest:object
interface
An interface representing ValidateIaasVMRestoreOperationRequest.
AzureRestoreValidation request.
{ProtectionStatus} [protectionState] State of the back up item.
Possible values include: 'Invalid', 'NotProtected', 'Protecting',
'Protected', 'ProtectionFailed'
{string} [workloadType] Type of workload for the backup management
type
type:object
className
className:string = "WorkloadItem"
name
name:"Composite" = "Composite"
uberParent
uberParent:string = "WorkloadItem"
modelProperties
modelProperties:object
backupManagementType
backupManagementType:object
serializedName
serializedName:string = "backupManagementType"
type
type:object
name
name:"String" = "String"
friendlyName
friendlyName:object
serializedName
serializedName:string = "friendlyName"
type
type:object
name
name:"String" = "String"
protectionState
protectionState:object
serializedName
serializedName:string = "protectionState"
type
type:object
name
name:"String" = "String"
workloadItemType
workloadItemType:object
required
required:true = true
serializedName
serializedName:string = "workloadItemType"
type
type:object
name
name:"String" = "String"
workloadType
workloadType:object
serializedName
serializedName:string = "workloadType"
type
type:object
name
name:"String" = "String"
polymorphicDiscriminator
polymorphicDiscriminator:object
clientName
clientName:string = "workloadItemType"
serializedName
serializedName:string = "workloadItemType"
Const WorkloadItemResource
WorkloadItemResource:object
interface
An interface representing WorkloadItemResource.
Base class for backup item. Workload-specific backup items are derived from
this class.
extends
Resource
Optional eTag
eTag:undefined | string
member
{string} [eTag] Optional ETag.
Optional id
id:undefined | string
member
{string} [id] Resource Id represents the complete path to the
resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Optional location
location:undefined | string
member
{string} [location] Resource location.
Optional name
name:undefined | string
member
{string} [name] Resource name associated with the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Determines whether all the members of an array satisfy the specified test.
Parameters
callbackfn: function
A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Returns the value of the first element in the array where predicate is true, and undefined
otherwise.
Type parameters
S: WorkloadItemResource
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found, find
immediately returns that element value. Otherwise, find returns undefined.
findIndex(predicate: function, thisArg?: any): number
Returns the index of the first element in the array where predicate is true, and -1
otherwise.
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found,
findIndex immediately returns that element index. Otherwise, findIndex returns -1.
reduce<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: WorkloadItemResource, currentIndex: number, array: WorkloadItemResource[]): U
Parameters
previousValue: U
currentValue: WorkloadItemResource
currentIndex: number
array: WorkloadItemResource[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
reduceRight<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: WorkloadItemResource, currentIndex: number, array: WorkloadItemResource[]): U
Parameters
previousValue: U
currentValue: WorkloadItemResource
currentIndex: number
array: WorkloadItemResource[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U
reverse
reverse(): WorkloadItemResource[]
Reverses the elements in an Array.
Returns WorkloadItemResource[]
shift
shift(): WorkloadItemResource | undefined
Removes the first element from an array and returns it.
Determines whether the specified callback function returns true for any element of an array.
Parameters
callbackfn: function
A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
{ProtectionStatus} [protectionState] State of the back up item.
Possible values include: 'Invalid', 'NotProtected', 'Protecting',
'Protected', 'ProtectionFailed'
serializedName
serializedName:string = "WorkloadProtectableItem"
Optional workloadType
workloadType:undefined | string
member
{string} [workloadType] Type of workload for the backup management
type
type:object
className
className:string = "WorkloadProtectableItem"
name
name:"Composite" = "Composite"
uberParent
uberParent:string = "WorkloadProtectableItem"
modelProperties
modelProperties:object
backupManagementType
backupManagementType:object
serializedName
serializedName:string = "backupManagementType"
type
type:object
name
name:"String" = "String"
friendlyName
friendlyName:object
serializedName
serializedName:string = "friendlyName"
type
type:object
name
name:"String" = "String"
protectableItemType
protectableItemType:object
required
required:true = true
serializedName
serializedName:string = "protectableItemType"
type
type:object
name
name:"String" = "String"
protectionState
protectionState:object
serializedName
serializedName:string = "protectionState"
type
type:object
name
name:"String" = "String"
workloadType
workloadType:object
serializedName
serializedName:string = "workloadType"
type
type:object
name
name:"String" = "String"
polymorphicDiscriminator
polymorphicDiscriminator:object
clientName
clientName:string = "protectableItemType"
serializedName
serializedName:string = "protectableItemType"
Const WorkloadProtectableItemResource
WorkloadProtectableItemResource:object
interface
An interface representing WorkloadProtectableItemResource.
Base class for backup item. Workload-specific backup items are derived from
this class.
extends
Resource
Optional eTag
eTag:undefined | string
member
{string} [eTag] Optional ETag.
Optional id
id:undefined | string
member
{string} [id] Resource Id represents the complete path to the
resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Optional location
location:undefined | string
member
{string} [location] Resource location.
Optional name
name:undefined | string
member
{string} [name] Resource name associated with the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
Determines whether all the members of an array satisfy the specified test.
Parameters
callbackfn: function
A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Returns the value of the first element in the array where predicate is true, and undefined
otherwise.
Type parameters
S: WorkloadProtectableItemResource
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found, find
immediately returns that element value. Otherwise, find returns undefined.
findIndex(predicate: function, thisArg?: any): number
Returns the index of the first element in the array where predicate is true, and -1
otherwise.
Parameters
predicate: function
find calls predicate once for each element of the array, in ascending
order, until it finds one where predicate returns true. If such an element is found,
findIndex immediately returns that element index. Otherwise, findIndex returns -1.
reduce<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: WorkloadProtectableItemResource, currentIndex: number, array: WorkloadProtectableItemResource[]): U
Parameters
previousValue: U
currentValue: WorkloadProtectableItemResource
currentIndex: number
array: WorkloadProtectableItemResource[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
reduceRight<U>(callbackfn: function, initialValue: U): U
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters
U
Parameters
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
(previousValue: U, currentValue: WorkloadProtectableItemResource, currentIndex: number, array: WorkloadProtectableItemResource[]): U
Parameters
previousValue: U
currentValue: WorkloadProtectableItemResource
currentIndex: number
array: WorkloadProtectableItemResource[]
Returns U
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Determines whether the specified callback function returns true for any element of an array.
Parameters
callbackfn: function
A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
{RetentionScheduleFormat} [retentionScheduleFormatType] Retention
schedule format for yearly retention policy. Possible values include:
'Invalid', 'Daily', 'Weekly'
Defines values for AzureFileShareType. Possible values include: 'Invalid', 'XSMB', 'XSync'
{string}